GET All Clients with Option to Expand Subresource

This request allows expanding sub-resources. When this query parameter is used, the specified child aggregate is expanded in the resource payload (instead of just a link). The value of this query parameter could be "all" where all children are expanded. More than one children can be specified using comma as a separator.

Example:/clients?expand=all.

Nested children can also be provided in "expand" in the following format "Child.Nested-child"

Example : ....../clients?expand=addresses,phones OR  ... /clients?expand=all

Resource/Request URI

http://server:port/PASService/rest/services//clients?expand=

Method

GET

Sample JSON Response

{
    "count": 1,
    "offset": 0,
    "limit": 25,
    "clients": [{
        "clientId": "5004D325-9C84-4755-B1C7-CA549A02DA9E",
        "Type": "Individual",
        "firstName": "Kaine",
        "lastName": "Majorie",
        "taxId": "1265118",
        "updatedDate": null,
        "legalResidenceCountryCode": "SG",
        "entityType": "Client",
        "status": "Active",
        "agentCode": "AG898989",
        "applicationType": "Normal",
        "bankAccount": "7878787",
        "Links": [{
                "rel": "self",
                "href": "http://localhost:8080/PASService/rest/services/clients/5004D325-9C84-4755-B1C7-CA549A02DA9E"
            },
            {
                "rel": "addresses",
                "href": "http: //localhost:8080/PASService/rest/services/clients/5004D325-9C84-4755-B1C7-CA549A02DA9E/addresses"
            },
            {
                "rel": "phones",
                "href": "http://localhost:8080/PASService/rest/services/clients/5004D325-9C84-4755-B1C7-CA549A02DA9E/phones"
            }
        ],
        "addresses": [{
            "addressId": "66457304DF3640 A4AF80D319B42741C5",
            "addressLine1 ": "123 Main St",
            "addressLine2": "Kingsway",
            "addressLine3": "more street",
            "addressLine4": null,
            "addressLine5": null,
            "addressLine6": null,
            "city": "Exton",
            "stateCode": "PA",
            "countryCode": "US",
            "postalId": "1234",
            "email": "janet@yahoo.com",
            "phone": "787878",
            "region": null,
            "municipalityCode": null,
            "effectiveDate": null,
            "expiryDate": null,
            "addressSource": null,
            "bankAccountNumber": null,
            "costOfStamp": null,
            "letterMailDate": null,
            "returnMailIndicator": null,
            "addressType": "Home",
            "default": "False",
            "phones": [{
                "phoneNumberId": "F435C4D5-E70C-4F3A-8DE2-3C46707E8911",
                "countryCode": "US",
                "phoneType": "Home",
                "status": "Active",
                "typeCode": null,
                "callingCode": null,
                "phoneNumber": "898989889",
                "extension": "1234",
                "preferred": "No"
            }]
        }],
        "phones": [{
                "PhoneId": "F435C4D5-E70C-4F3A-8DE2-3C46707E89A9",
                "countryCode": "US",
                "phoneType": "Home",
                "status": "Active",
                "typeCode": null,
                "callingCode": null,
                "phoneNumber": "898989889",
                "extension": "1234",
                "preferred": "No"
            },
            {
                "PhoneId": "F435C4D5-E70C-4F3A-8DE2-3C46707E8900",
                "countryCode": "US",
                "phoneType": "Home",
                "status": "Active",
                "typeCode": null,
                "callingCode": null,
                "phoneNumber": "898989889",
                "extension": "1234",
                "preferred": "No"
            }
        ]
    }]
}